Skip to main content
Version: 3.7

Usage Policies

Usage policies streamline API traffic management, ensuring system stability and optimal functionality.

usagepolicies

Search a Usage Policy​

The Search tool on the Usage Policy list pages allows the user to search for a Usage Policy.

searchpolicy

  1. Click the Search icon.

The pop up appears as shown below.

searchpolicy1

  1. Enter the Key word.

  2. Click Search.

The Search results appears as shown below.

searchpolicy2

Sort Usage Policy​

The sort capability allows you to arrange Usage Policy in a certain order based on predefined criteria.

  1. Click on the Policy Name to apply sort ascending.

sortpolicy

On applying sort ascending, the upward arrow will be highlighted.

  1. Click on the Policy Name again to sort descending.

sortpolicy1

On applying sort descending, the downward arrow will be highlighted.

  1. Click on the Policy Name again to cancel sorting.

sortpolicy2

Cancelling sort disables both the upward and downward arrows.

sortpolicy3

Filter the Usage Policy​

The Filters allow users to restrict or limit the displayed data based on Policy type and its State, which helps in focusing on the relevant data.

Filter by Policy Type​

  1. Click the Filter icon available next to the Policy Type.

filterpolicytype

The drop down appears as shown below.

filterpolicytype1

  1. Enable the checkboxes next to the filter options to select them.

  2. Click OK.

On proceeding, the results are displayed with the highlighted filter icon, shown below.

filterpolicytype2

  1. To reset the filter, click the Filter icon, then select the Reset button, and click OK to confirm.

filterpolicytype3

Filter by Policy Status​

  1. Click the Filter icon available next to the Policy Status.

filterpolicystatus

The drop down appears as shown below.

filterpolicystatus1

  1. Enable the checkboxes next to the filter options to select them.

  2. Click OK.

On proceeding, the results are displayed with the highlighted filter icon, shown below.

filterpolicystatus2

info

To reset the filter, click the Filter icon, then select the Reset button, and click OK to confirm.

Export all approved and published Usage Policies​

The Export function allows users to download all approved and published Usage Policies for purposes such as backup, migration, etc.

exportallusagepolicies

  1. Click the Cogwheel icon.

The drop down appears as shown below.

exportallusagepolicies1

  1. Click Export to download all the all approved and published Usage Policies in zip format.

Import all approved and published Usage Policies​

The Import functionality enables users to upload Usage Policies, making it easier to migrate it between environments, restore backups, etc.

exportallusagepolicies

  1. Click the Cogwheel icon.

The drop down appears as shown below.

importallusagepolicies

  1. Click Import.

The Import Usage Policies dialog box appears as shown below.

info

There are two methods for importing Approved and Published Usage Policies:

  • Full Import - The existing artifacts will be removed from this deployment and the artifacts in the imported file shall be populated. SSL certificates, if any, must be manually configured.

  • Delta Import - If the artifact being imported already exists in this instance, it will be updated with the information from the imported file. Artifacts present in this instance but not in the imported file will be left untouched. If the artifact being imported does not exist in this instance, it will be created. SSL certificates, if any, must be configured manually.

  1. Select the Import method as either Full Import or Delta Import as per the requirement.

  2. Click to Upload the backup file from your local disk.

  3. Click Import to import the file.